Skip to content

📝 Clarify logging configuration in absespy.yaml#139

Merged
SongshGeo merged 2 commits intomasterfrom
dev
Jan 7, 2026
Merged

📝 Clarify logging configuration in absespy.yaml#139
SongshGeo merged 2 commits intomasterfrom
dev

Conversation

@SongshGeo
Copy link
Copy Markdown
Collaborator

@SongshGeo SongshGeo commented Jan 7, 2026 •
edited by coderabbitai Bot
Loading

Summary by CodeRabbit

  • Chores
    • Simplified logging configuration by removing redundant file handler settings.
    • Added informational logging to batch operations for better visibility into execution parameters.
    • Updated experiment logging to record completion status.
    • Minor documentation formatting improvements.

✏️ Tip: You can customize this high-level summary in your review settings.

@SongshGeo
fix(logging): 🔊 Enhance experiment logging with additional info message
1d35a9a 
This commit adds an info log message in the `Experiment` class to indicate the number of repeats and parallels when running an experiment. Additionally, it updates the logging message in the `fire_spread` example to reflect when the experiment has finished, improving the clarity of the logging output during execution.
@SongshGeo
fix(logging): 📝 Clarify logging configuration in absespy.yaml
892f098 
This commit updates the comments in the `absespy.yaml` file to clarify that the 'file' handler is not defined, as ABSESpy configures its own file logging through the `log.run.file` settings. This change enhances the understanding of the logging setup for users and developers.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 7, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The PR modifies logging configuration and instrumentation across the ABSESpy codebase. Changes include clarifying file handler documentation in the logging configuration file, adding informational logging to record batch run parameters, adjusting example log messages from experiment start to completion, and minor documentation formatting.

Changes

Cohort / File(s) Summary
Logging Configuration
abses/conf/absespy.yaml		 Removed explicit file: null directive and replaced with comments clarifying that ABSESpy uses its own file logging via runtime configuration instead of default file handlers.
Core Logging Instrumentation
abses/core/experiment.py		 Added informational log at the start of Experiment.batch_run() to record the number of repeats and parallels before deep-copying configuration.
Example Updates
examples/fire_spread/model.py		 Modified log message after batch_run() from "Experiment {exp.name} started" to "Experiment {exp.name} finished!", moving the log from execution initiation to completion.
Documentation
docs/api/analysis.md		 Added trailing blank line for formatting consistency.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Logs now whisper at the start and cheer at journey's end,
Configuration clarified, no mysteries to mend,
Batch runs counted, experiments tracked with care,
ABSESpy's logging grows more transparent in the air! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title focuses on clarifying logging configuration in absespy.yaml, but the PR also includes changes to experiment.py, model.py, and analysis.md that are unrelated to the stated objective. Update the title to reflect all significant changes in the PR, such as 'Improve logging and documentation across multiple files' or list the primary changes more comprehensively.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom Pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 65829e3 and 892f098.

📒 Files selected for processing (4)
  • abses/conf/absespy.yaml
  • abses/core/experiment.py
  • docs/api/analysis.md
  • examples/fire_spread/model.py
🧰 Additional context used
🧬 Code graph analysis (2)
abses/core/experiment.py (1)
abses/utils/log_config.py (1)
  • info (475-477)
examples/fire_spread/model.py (2)
abses/core/model.py (2)
  • exp (407-409)
  • name (158-165)
abses/core/experiment.py (2)
  • logger (195-211)
  • name (183-192)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)
  • GitHub Check: Tests 3.11 on windows-latest
  • GitHub Check: Tests 3.11 on macos-latest
  • GitHub Check: Tests 3.13 on windows-latest
  • GitHub Check: Tests 3.12 on windows-latest
  • GitHub Check: Tests 3.12 on ubuntu-latest
  • GitHub Check: Tests 3.11 on ubuntu-latest
  • GitHub Check: Tests 3.13 on macos-latest
  • GitHub Check: Tests 3.12 on macos-latest
  • GitHub Check: Tests 3.13 on ubuntu-latest
  • GitHub Check: nbmake
  • GitHub Check: nbmake
🔇 Additional comments (4)
docs/api/analysis.md (1)

12-12: LGTM!

Adding a trailing blank line improves formatting consistency.

examples/fire_spread/model.py (1)

182-182: LGTM! Improved logging accuracy.

The log message now correctly reflects that it's recorded after batch_run() completes, improving the clarity of experiment lifecycle logging.

abses/core/experiment.py (1)

596-598: LGTM! Enhanced observability.

Logging the batch run parameters at the start provides valuable visibility into the experiment configuration and improves debugging capabilities.

abses/conf/absespy.yaml (1)

27-28: LGTM! Clarified logging architecture.

The comments effectively document that ABSESpy manages its own file logging through the log.run.file settings, making the configuration intent clear and improving maintainability.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@SongshGeo SongshGeo merged commit 4a0c9f4 into master Jan 7, 2026
13 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@SongshGeo